Skip to content

Correct the README's test count, and name python as a prerequisite - #4

Merged
StepenkoAnatoli merged 1 commit into
mainfrom
docs/readme-test-count
Sep 20, 2026
Merged

StepenkoAnatoli merged 1 commit into
mainfrom
docs/readme-test-count

Conversation

@StepenkoAnatoli

Copy link
Copy Markdown
Owner

The README said 326 tests in the present tense; the suite has been at 565 since 90a22a9. It also listed UNSUP prerequisites as "no POSIX shell, no git" — since 9f9b604 a missing python blocks too, and that is the case a reader most needs to know, because it is the cross-language conformance tests it stops.

Found during a repository review that flagged the stale count. I verified it, and also verified the review's other checkable claims: CI is ubuntu-latest only, and release-validator.mjs is 1324 lines with 21 exports — all three exactly as reported.

Deliberately not changed: the counts in docs/adr/0022 (556), docs/adr/0029 (556) and docs/build-report-2026-09-17-tier3.md (326). Those are dated records of what was true when written; an ADR that silently acquires today's numbers stops being a decision record. Only the README made a present-tense claim.

node research-kit/bin/selftest.mjs    -> 565 passed, 0 failed
node research-kit/bin/preflight.mjs   -> PASS, 0 blocking, 0 warnings

🤖 Generated with Claude Code

WHAT CHANGED
  research-kit/README.md   "326 tests" -> "565 tests"
                           UNSUP prerequisites now name python alongside sh and git

WHY
  The README stated 326 in the present tense. The suite has been at 565 since
  90a22a9. A reader checking the project's claims against `selftest.mjs` would
  find the first number they tested was wrong, which is the cheapest possible way
  to lose their trust in the rest.

  The second line was stale in a subtler way: it listed "no POSIX shell, no git"
  as the prerequisites that produce UNSUP. Since 9f9b604 a missing python does
  too, and that is precisely the case a reader most needs to know about, because
  the cross-language conformance tests are the ones it blocks.

WHAT I DID NOT CHANGE
  The counts in docs/adr/0022 (556), docs/adr/0029 (556) and
  docs/build-report-2026-09-17-tier3.md (326). Those are dated records of what
  was true when they were written. An ADR that silently acquires today's numbers
  stops being a decision record. Only the README makes a present-tense claim.

WHAT I VERIFIED
  node research-kit/bin/selftest.mjs    -> 565 passed, 0 failed
  node research-kit/bin/preflight.mjs   -> PASS, 0 blocking, 0 warnings
  grep for 326/556/559/565 across *.md  -> only the README claimed the present

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@StepenkoAnatoli
StepenkoAnatoli merged commit decfedd into main Sep 20, 2026
1 check passed
@StepenkoAnatoli
StepenkoAnatoli deleted the docs/readme-test-count branch September 20, 2026 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant